Skip to main content
Version: V3.0

Booking Management API


Get Amenity List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
page_sizeIntegerBodyYesPage size
page_indexIntegerBodyYesPage index

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
result[]Object<result>BodyReturn result

result description

Parameter NameTypeLocationDescription
amenity_idStringBodyAmenity ID
amenity_nameStringBodyAmenity name
amenity_descriptionStringBodyAmenity description
amenity_picture_urlStringBodyAmenity picture URL
buildings[]Object<building>BodyBuilding information
devices[]Object<device>BodyDevice information
enableBooleanBodyWhether the amenity is enable or not?
true: enable
false: disable
contactStringBodyContact
contact_informationStringBodyContact information
start_timeStringBodyStart time, UTC
finish_timeStringBodyFinish time, UTC
available_days[]StringBodyAvailable days
maximum_durationIntegerBodyMaximum duration (min)
maximum_advanceIntegerBodyMaximum advance (d)
maximum_reservationIntegerBodyMaximum reservation
maximum_password_countIntegerBodyMaximum password count
require_approvalBooleanBodyWhether the amenity requires approval or not?
true: require
false: not require

building description

Parameter NameTypeLocationDescription
building_idStringBodyBuilding ID
building_nameStringBodyBuilding name

device description

Parameter NameTypeLocationDescription
device_idStringBodyDevice ID
device_nameStringBodyDevice name

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_amenity_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"page_size": 1,
"page_index": 1,
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"amenity_id": "afa332e258aae1badbb27d31128f442dc",
"amenity_name": "Gym",
"amenity_description": "test",
"amenity_picture_url": "https://test.akubela.com/g",
"buildings": [
{
"building_id": "bafa332e258aae1badbb27d31128f442d",
"building_name": "001"
}
],
"devices": [
{
"device_id": "dwbdbbafa332e258aae1badbb27d31128",
"device_name": "device"
}
],
"enable": true,
"contact": "test",
"contact_information": "1234567",
"start_time": "13:14",
"finish_time": "15:14",
"available_days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"maximum_duration": 30,
"maximum_advance": 1,
"maximum_reservation": 1,
"maximum_password_count": 20,
"require_approval": true
}
]
}

Failure Return Example

See Failure Return Example



Get Amenity Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
amenity_idStringBodyYesAmenity ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObject<result>BodyReturn result

result description

Parameter NameTypeLocationDescription
amenity_nameStringBodyAmenity name
amenity_descriptionStringBodyAmenity description
amenity_picture_urlStringBodyAmenity picture URL
buildings[]Object<building>BodyBuilding information
devices[]Object<device>BodyDevice information
enableBooleanBodyWhether the amenity is enable or not?
true: enable
false: disable
contactStringBodyContact
contact_informationStringBodyContact information
start_timeStringBodyStart time, UTC
finish_timeStringBodyFinish time, UTC
available_days[]StringBodyAvailable days
maximum_durationIntegerBodyMaximum duration (min)
maximum_advanceIntegerBodyMaximum advance (d)
maximum_reservationIntegerBodyMaximum reservation
maximum_password_countIntegerBodyMaximum password count
require_approvalBooleanBodyWhether the amenity requires approval or not?
true: require
false: not require

building description

Parameter NameTypeLocationDescription
building_idStringBodyBuilding ID
building_nameStringBodyBuilding name

device description

Parameter NameTypeLocationDescription
device_idStringBodyDevice ID
device_nameStringBodyDevice name

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_amenity_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"amenity_id": "afa332e258aae1badbb27d31128f442dc"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"amenity_name": "Gym",
"amenity_description": "test",
"amenity_picture_url": "https://test.akubela.com/g",
"buildings": [
{
"building_id": "bafa332e258aae1badbb27d31128f442d",
"building_name": "001"
}
],
"devices": [
{
"device_id": "dwbdbbafa332e258aae1badbb27d31128",
"device_name": "device"
}
],
"enable": true,
"contact": "test",
"contact_information": "1234567",
"start_time": "13:14",
"finish_time": "15:14",
"available_days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"maximum_duration": 30,
"maximum_advance": 1,
"maximum_reservation": 1,
"maximum_password_count": 20,
"require_approval": true
}
}

Failure Return Example

See Failure Return Example



Get Creating Amenity List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObject<result>BodyReturn result

result description

Parameter NameTypeLocationDescription
buildings[]Object<building>BodyBuilding information
devices[]Object<device>BodyDevice information

building description

Parameter NameTypeLocationDescription
building_idStringBodyBuilding ID
building_nameStringBodyBuilding name

device description

Parameter NameTypeLocationDescription
device_idStringBodyDevice ID
device_nameStringBodyDevice name

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_creating_amenity_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"buildings": [
{
"building_id": "b8f39bda1a956435d96be126854c61318",
"building_name": "test"
}
],
"devices": [
{
"device_id": "db8f39bda1a956435d96be126854c6131",
"device_name": "device"
}
]
}
}

Failure Return Example

See Failure Return Example



Create Amenity Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
amenity_nameStringBodyYesAmenity name
amenity_descriptionStringBodyYesAmenity description
amenity_picture_urlStringBodyYesAmenity picture URL
buildings[]Object<building>BodyYesBuilding information
devices[]Object<device>BodyYesDevice information
enableBooleanBodyYesWhether the amenity is enable or not?
true: enable
false: disable
contactStringBodyYesContact
contact_informationStringBodyYesContact information
start_timeStringBodyYesStart time, UTC
finish_timeStringBodyYesFinish time, UTC
available_days[]StringBodyYesAvailable days
maximum_durationIntegerBodyYesMaximum duration (min)
maximum_advanceIntegerBodyYesMaximum advance (d)
maximum_reservationIntegerBodyYesMaximum reservation
maximum_password_countIntegerBodyYesMaximum password count
require_approvalBooleanBodyYesWhether the amenity requires approval or not?
true: require
false: not require

building description

Parameter NameTypeLocationRequiredDescription
building_idStringBodyYesBuilding ID
building_nameStringBodyYesBuilding name

device description

Parameter NameTypeLocationRequiredDescription
device_idStringBodyYesDevice ID
device_nameStringBodyYesDevice name

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObject<result>BodyReturn result

result description

Parameter NameTypeLocationDescription
amenity_idStringBodyAmenity ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "create_amenity_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
"amenity_name": "Gym",
"amenity_description": "test",
"amenity_picture_url": "https://test.akubela.com/g",
"buildings": [
{
"building_id": "bafa332e258aae1badbb27d31128f442d",
"building_name": "001"
}
],
"devices": [
{
"device_id": "dwbdbbafa332e258aae1badbb27d31128",
"device_name": "device"
}
],
"enable": true,
"contact": "test",
"contact_information": "1234567",
"start_time": "13:14",
"finish_time": "15:14",
"available_days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"maximum_duration": 30,
"maximum_advance": 1,
"maximum_reservation": 1,
"maximum_password_count": 20,
"require_approval": true
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"amenity_id": "abafa332e258aae1badbb27d31128f442"
}
}

Failure Return Example

See Failure Return Example



Update Amenity Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
amenity_idStringBodyAmenity ID
amenity_nameStringBodyYesAmenity name
amenity_descriptionStringBodyYesAmenity description
amenity_picture_urlStringBodyYesAmenity picture URL
buildings[]Object<building>BodyYesBuilding information
devices[]Object<device>BodyYesDevice information
enableBooleanBodyYesWhether the amenity is enable or not?
true: enable
false: disable
contactStringBodyYesContact
contact_informationStringBodyYesContact information
start_timeStringBodyYesStart time, UTC
finish_timeStringBodyYesFinish time, UTC
available_days[]StringBodyYesAvailable days
maximum_durationIntegerBodyYesMaximum duration (min)
maximum_advanceIntegerBodyYesMaximum advance (d)
maximum_reservationIntegerBodyYesMaximum reservation
maximum_password_countIntegerBodyYesMaximum password count
require_approvalBooleanBodyYesWhether the amenity requires approval or not?
true: require
false: not require

building description

Parameter NameTypeLocationRequiredDescription
building_idStringBodyYesBuilding ID
building_nameStringBodyYesBuilding name

device description

Parameter NameTypeLocationRequiredDescription
device_idStringBodyYesDevice ID
device_nameStringBodyYesDevice name

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "update_amenity_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
"amenity_id": "abafa332e258aae1badbb27d31128f442",
"amenity_name": "Gym",
"amenity_description": "test",
"amenity_picture_url": "https://test.akubela.com/g",
"buildings": [
{
"building_id": "bafa332e258aae1badbb27d31128f442d",
"building_name": "001"
}
],
"devices": [
{
"device_id": "dwbdbbafa332e258aae1badbb27d31128",
"device_name": "device"
}
],
"enable": true,
"contact": "test",
"contact_information": "1234567",
"start_time": "13:14",
"finish_time": "15:14",
"available_days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"maximum_duration": 30,
"maximum_advance": 1,
"maximum_reservation": 1,
"maximum_password_count": 20,
"require_approval": true
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example



Delete Amenity Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
amenity_idStringBodyYesAmenity ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "delete_amenity_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"amenity_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example



Batch Delete Amenity Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
amenities[]Object<amenity>BodyYesAmenity information

amenity description

Parameter NameTypeLocationRequiredDescription
amenity_idStringBodyYesAmenity ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "batch_delete_amenity_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"amenities": [
{
"amenity_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
}
]
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example



Enable Amenity

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
amenity_idStringBodyYesAmenity ID
enableBooleanBodyYesWhether the amenity is enable or not?
true: enable
false: disable

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "enable_amenity",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
"amenity_id": "afa332e258aae1badbb27d31128f442dc",
"enable": true
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example



Get Booking List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
page_sizeIntegerBodyYesPage size
page_indexIntegerBodyYesPage index

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
result[]Object<result>BodyReturn result

result description

Parameter NameTypeLocationDescription
residence_idStringBodyResidence ID
booking_idStringBodyBooking ID
amenity_idStringBodyAmenity ID
amenity_nameStringBodyAmenity name
amenity_descriptionStringBodyAmenity description
amenity_picture_urlStringBodyAmenity picture URL
building_nameStringBodyBuilding name
family_nameStringBodyFamily name
residence_noStringBodyResidence number
start_timeStringBodyStart time, UTC
finish_timeStringBodyFinish time, UTC
stateStringBodyState, pending or rejected or canceled or success
is_expiredBooleanBodyWhether the booking is expired or not?
true: yes
false: no
pin_codeStringBodyPIN code
qr_code_urlStringBodyQR code URL
created_timeStringBodyCreated time, UTC
account_idStringBodyAccount ID
account_nameStringBodyAccount name
first_nameStringBodyFirst name
last_nameStringBodyLast name
emailStringBodyEmail
phoneStringBodyPhone

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_booking_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"page_size": 1,
"page_index": 1,
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"residence_id": "rm31adc223cc4b3bedb6bd4742dedcfa5",
"booking_id": "bfa332e258aae1badbb27d31128f442d1",
"amenity_id": "afa332e258aae1badbb27d31128f442dc",
"amenity_name": "Gym",
"amenity_description": "test",
"amenity_picture_url": "https://test.akubela.com/g",
"building_name": "001",
"family_name": "home",
"residence_no": "505",
"start_time": "2024-05-02 13:14:15",
"finish_time": "2024-05-02 15:14:15",
"state": "pending",
"is_expired": true,
"pin_code": "123456",
"qr_code_url": "https://test.akubela.com/h.png",
"created_time": "2024-05-01 13:32:45",
"account_id": "arm31adc223cc4b3bedb6bd4742dedcfa",
"account_name": "test@akubela.com",
"first_name": "clay",
"last_name": "sagan",
"email": "test@akubela.com",
"phone": "1234567"
}
]
}

Failure Return Example

See Failure Return Example



Get Booking Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
booking_idStringBodyYesBooking ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObject<result>BodyReturn result

result description

Parameter NameTypeLocationDescription
residence_idStringBodyResidence ID
amenity_idStringBodyAmenity ID
amenity_nameStringBodyAmenity name
amenity_descriptionStringBodyAmenity description
amenity_picture_urlStringBodyAmenity picture URL
building_nameStringBodyBuilding name
family_nameStringBodyFamily name
residence_noStringBodyResidence number
start_timeStringBodyStart time, UTC
finish_timeStringBodyFinish time, UTC
stateStringBodyState, pending or rejected or canceled or success
is_expiredBooleanBodyWhether the booking is expired or not?
true: yes
false: no
pin_codeStringBodyPIN code
qr_code_urlStringBodyQR code URL
created_timeStringBodyCreated time, UTC
account_idStringBodyAccount ID
account_nameStringBodyAccount name
first_nameStringBodyFirst name
last_nameStringBodyLast name
emailStringBodyEmail
phoneStringBodyPhone

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_booking_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"booking_id": "b31adc223cc4b3bedb6bd4742dedcfa52"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"residence_id": "rm31adc223cc4b3bedb6bd4742dedcfa5",
"booking_id": "bfa332e258aae1badbb27d31128f442d1",
"amenity_id": "afa332e258aae1badbb27d31128f442dc",
"amenity_name": "Gym",
"amenity_description": "test",
"amenity_picture_url": "https://test.akubela.com/g",
"building_name": "001",
"family_name": "home",
"residence_no": "505",
"start_time": "2024-05-02 13:14:15",
"finish_time": "2024-05-02 15:14:15",
"state": "pending",
"is_expired": true,
"pin_code": "123456",
"qr_code_url": "https://test.akubela.com/h.png",
"created_time": "2024-05-01 13:32:45",
"account_id": "arm31adc223cc4b3bedb6bd4742dedcfa",
"account_name": "test@akubela.com",
"first_name": "clay",
"last_name": "sagan",
"email": "test@akubela.com",
"phone": "1234567"
}
]
}

Failure Return Example

See Failure Return Example



Update Booking Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
booking_idStringBodyYesBooking ID
stateStringBodyYesState, rejected or success

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "update_booking_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
"booking_id": "bfa332e258aae1badbb27d31128f442dc",
"state": "rejected"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example



Delete Booking Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
booking_idStringBodyYesBooking ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "delete_booking_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"booking_id": "b8b5a73f8dd84abaa94dcs248be49b0d1"
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example



Batch Delete Booking Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter NameTypeLocationRequiredDescription
Content-TypeStringHeaderYesContent type, the value is application/json
AcceptStringHeaderYesAccept, the value is application/json
AuthorizationStringHeaderYesBearer authorization, access token
commandStringBodyYesCommand name
idStringBodyYesCommand ID
paramObject<param>BodyYesCommand parameter

param description

Parameter NameTypeLocationRequiredDescription
project_idStringBodyYesProject ID
bookings[]Object<booking>BodyYesBooking information

booking description

Parameter NameTypeLocationRequiredDescription
booking_idStringBodyYesBooking ID

Return Parameter

Parameter NameTypeLocationDescription
Content-TypeStringHeaderContent type, the value is application/json
successBooleanBodyWhether the request is successful or not?
true: success
false: failure
timestampIntegerBodyTimestamp
resultObjectBodyReturn result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "batch_delete_booking_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"bookings": [
{
"booking_id": "b8b5a73f8dd84abaa94dcs248be49b0d1"
}
]
}
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

Failure Return Example

See Failure Return Example